home *** CD-ROM | disk | FTP | other *** search
/ CD ROM Paradise Collection 4 / CD ROM Paradise Collection 4 1995 Nov.iso / database / dates410.zip / DATES.DOC < prev    next >
Text File  |  1994-10-20  |  12KB  |  291 lines
  1. DATES.DOC
  2. 10/20/94
  3.  
  4. This program keeps track of birthdays, anniversaries, coming events, etc giving
  5. you advance warning so you can send out cards, leave town, etc.  Features of
  6. this program:
  7.  
  8.   * Initially defaults to showing all events happening within 14 days
  9.   * You can set up multiple date files, each with their own day threshold;
  10.     for example, one file for birthdays, another for business meetings, etc
  11.   * This program can be included in your AUTOEXEC.BAT file to provide notices
  12.     every time you turn on your PC.
  13.   * Vague dates can be entered (e.g. "11/XX/XX Thanksgiving) when the exact
  14.     day varies from year to year
  15.   * Dates can be in the United States format (/DATE=mm/dd/yy) or in most other
  16.     formats (e.g. /DATE=dd-mm-yy)
  17.   * Months can be entered as sequential months (1 for January, 2 for February,
  18.     etc) or else entered as the months themselves (JAN, FEB, etc)
  19.   * Dates don't have to be padded (9/6/94, 09/06/94, and SEP/06/1994 are all
  20.     accepted)
  21.   * The program will show you the weekday and age of the event if desired
  22.   * Comment lines can be displayed if desired (e.g. "Events relating to work:")
  23.   * The program can automatically pause when done if desired
  24.  
  25. The dates file is a simple ASCII text file, created and maintained with any text
  26. editor.  Each record should begin with a date (typically in mm/dd/yy format)
  27. followed by a description of the event.  For example:
  28.  
  29.         05/05/93 Lucy Baines
  30.  
  31. Blank lines or any line which begins with a colon (":") or semi-colon (";") are
  32. ignored by the program.  Lines which begin with an asterisk ("*") are printed
  33. verbatim (minus the asterisk); add spacing after the asterisk if you want the
  34. lines to be indented upon display.
  35.  
  36. For the date portion of the record, you have some flexibility.  Initially by
  37. default, the program expects dates to be in a mm/dd/yy format.  So August 5,
  38. 1993 is "08/05/93".
  39.  
  40. You can change the sequence of the numbers by using the "/DATE=format" option.
  41. For example, you can specify "/DATE=dd-mm-yy" if you want.
  42.  
  43. Typically, most date formats will use one of the delimiters "-", ".", or "/"
  44. between all various day, month, and year fields.  For example, /DATE=dd.mm.yy
  45. instead of /DATE=dd.mm/dd.  If this is done, your input fields can entered in a
  46. very flexible manner.  The routine will parse the date field based on the
  47. delimiters and accept fields with or without padding, years with or without the
  48. century, and alphabetic months instead of just numeric ones.  For example, using
  49. /DATE=dd.mm.yy, all of the following September 5, 1994 events as the same:
  50.  
  51.         05.09.94 Big event
  52.         5.9.94 Same event
  53.         5.sep.1994 Still the same thing
  54.         05.september.1994 And yet again the same event
  55.  
  56.  
  57. The month portion of the date *has* to be filled in.  The day and year portions
  58. can be "xx" if desired.  If a day is "xx", you will be given the notice for the
  59. entire month and for 15 days before the start of the month.  For dates which
  60. vary from year to year (e.g.  Thanksgiving), you can either use the "xx" option
  61. for the day or revise the file every year.
  62.  
  63. Records in the file don't have to be in any particular order.  The dates will be
  64. presented in the order they appear in the file so putting them in chronological
  65. order makes the most sense.
  66.  
  67. A sample DATES.TXT file is provided and consists of the following lines:
  68.  
  69.         01/01/xx New Year's Day
  70.         01/20/xx -ish Martin Luther King's birthday
  71.         02/14/xx Valentine's Day
  72.         03/17/xx St. Patrick's Day
  73.         03/30/xx -ish Easter
  74.         04/07/xx -ish Daylight Savings Time begins
  75.         05/10/xx -ish Mother's Day
  76.         05/30/xx -ish Memorial Day
  77.         05/31/57 Bruce Guthrie
  78.         07/04/xx July 4th
  79.         09/02/xx -ish Labor Day
  80.         10/27/xx -ish Daylight Savings Time ends
  81.         10/31/xx Halloween
  82.         11/xx/xx Thanksgiving
  83.         11/11/xx Veteran's Day
  84.         11/20/xx -ish Thanksgiving
  85.         12/25/xx Christmas
  86.  
  87.  
  88.  
  89. Multiple input files with different date restrictions:
  90.  
  91. You can specify multiple date input files.  They are processed in the order
  92. they are entered.  By default, each will have the initial date restriction
  93. (typically 14 days).  You can override the date restriction for a specific file
  94. by including the date restriction after the file name.  For example:
  95.  
  96.         DATES DATE1.TXT DATE2.TXT /D10 DATE3.TXT
  97.  
  98. Given a default 14-day restriction, the date restrictions will be 14 days for
  99. DATE1.TXT and DATE3.TXT, 10 days for DATE2.TXT.  If you want to override the
  100. date restriction for all files, include that date restriction before the file
  101. name.  For example:
  102.  
  103.         DATES /D5 DATE1.TXT DATE2.TXT /D10 DATE3.TXT
  104.  
  105. In this case, the date restriction will be 5 days for DATE1.TXT and DATE3.TXT
  106. and 10 days for DATE2.TXT.
  107.  
  108.  
  109. The DATES.INI file:
  110.  
  111. DATES will read a DATES.INI file if one is found.  (You can specify a different
  112. file name if desired.) The file is an ASCII text file that can be created
  113. maintained by hand.  The file can consist or one or more command line
  114. parameters (only those that begin with a "/"), one statement per line.
  115.  
  116. The file can also contain comments which are blank lines or any line beginning
  117. with:
  118.         ;    (semi-colon)
  119.         :    (colon)
  120.         '    (quote)
  121.  
  122. DATES looks for the initialization file in your default subdirectory first.  It
  123. then searches for it in the subdirectory where the executable was and then goes
  124. through your DOS path.
  125.  
  126. Passing in "/INULL" skips loading the DATES.INI file.
  127.  
  128.  
  129.  
  130. Syntax:
  131.  
  132.     DATES [ date_file [...] ] [ /Ddays ] [ /-AGE | /AGE ] [ /COLOR=nnn nnn nnn ]
  133.       [ /CLS | /-CLS ] [ /Q | /-Q ] [ /Iinitfile | /-I ] [ /R ]
  134.       [ /DAY | /-DAY ] [ /MONO | /COLOR ] [ /SKIP | /-SKIP ] [ /P | /Pn | /-P ]
  135.       [ /W | /W0 | /-W ] [ /DATE=format ] [ /? ] [ > filename ]
  136.  
  137. where:
  138.  
  139. "date_file" is the name of the input text file.  It can contain drive and path
  140. information if desired.  This defaults to DATES.TXT.  If no filename is
  141. specified, the program will check for it along your DOS path beginning with your
  142. default subdirectory.  Multiple date files and date restrictions are allowed.
  143. See the notes above about this.
  144.  
  145. "/Ddays" (or "days") are the number of days in advance you want the warning.
  146. Initially defaults to /D14.  Note that generic days ("11/xx/xx") are not
  147. affected by this setting; you automatically get the notice 14 (or whatever) days
  148. before the beginning of the month.
  149.  
  150. "/AGE" shows the age of the event when it's printed.  This is only done for
  151. entries that have a specific year.  This is the default.
  152.  
  153. "/-AGE" skips showing the age of the event.  The default is /AGE.
  154.  
  155. "/COLOR=nnn nnn nnn" specifies the color settings to use for (in order) regular
  156. text, dates happening today, and the ages of dates happening today.  Any input
  157. lines which begin with an asterisk are printed using the third color set.  Each
  158. setting must consist of three digits, the first two being the foreground color
  159. and the last being the background color.  The foreground color should be padded
  160. on the left with a 0 if it is only one digit in length.  Defaults to "COLOR=070
  161. 150 090".
  162.  
  163. Foreground colors:
  164.  
  165.         Low intensity           High intensity
  166.  
  167.         0 = black                8 = dark grey
  168.         1 = blue                 9 = light blue
  169.         2 = green               10 = light green
  170.         3 = cyan                11 = light cyan
  171.         4 = red                 12 = light red
  172.         5 = magenta             13 = light magenta
  173.         6 = brown               14 = light yellow
  174.         7 = white               15 = bright white
  175.  
  176. Adding 16 to any color will make the text blink.  Background colors can consist
  177. of 0 to 7 above.  Bright white on blue, for example, would be "151".
  178.  
  179. "/CLS" clears the display before showing the results.
  180.  
  181. "/-CLS" does not clear the display first.  This is the default.
  182.  
  183.  
  184. "/Q" stops the printing every message except for the actual date lines.  This
  185. option is automatically invoked if redirection is used.
  186.  
  187. "/-Q" turns back on the printing of almost every message.  This is the default
  188. unless redirection is used.
  189.  
  190. "/Iinitfile" says to read an initialization file with the file name "initfile".
  191. The file specification *must* contain a period.  If no drive or path information
  192. is specified, the program will search for initfile beginning in your default
  193. subdirectory and then going throughout your DOS path.  The use of an
  194. initialization file is optional.  Initially defaults to "/IDATES.INI".
  195.  
  196. "/-I" (or "/INULL") says to skip loading the initialization file.
  197.  
  198. "/R" sets a DOS return code equal to the number of dates found.  The standard
  199. way to use something like this is with a test on the DOS ERRORLEVEL in an
  200. AUTOEXEC.BAT file or something.  For example:
  201.  
  202.        DATES /R
  203.        IF NOT ERRORLEVEL 0 GOTO END
  204.        PAUSE
  205.        :END
  206.        ECHO DONE
  207.  
  208. Note that the results of particular example could have been done easier using
  209. DATES' /W parameter.
  210.  
  211. "/DAY" shows the day of the week if possible.
  212.  
  213. "/-DAYS" skips showing the day of the week.  This is initially the default.
  214.  
  215. "/MONO" suppresses all screen color settings.
  216.  
  217. "/COLOR" allows screen color settings and is initially the default.
  218.  
  219. "/SKIP" says to print a message (unless /Q is specified) but otherwise ignore
  220. it if one or more of the date input files is not found.
  221.  
  222. "/-SKIP" says to abort if any of the input files are not found.
  223.  
  224. "/P" says to pause the output every 23 lines.  (NOTE:  The /P, /Pn, and /-P
  225. options affect pausing while listing events; the /W, /W0, /-W options affect
  226. pausing after the program finishes.)
  227.  
  228. "/Pn" says to pause the output every n-number of lines.
  229.  
  230. "/-P" says to not pause the output at all.  This is initially the default.
  231.  
  232. "/W" says to pause with a "Press any key to continue" message after the
  233. program finishes if any hits were found.
  234.  
  235. "/W0" says to pause afterward whether any hits were found or not.
  236.  
  237. "/-W" says to not pause afterward at all.  This is initially the default.
  238.  
  239.  
  240. "/DATE=format" specifies the format that the date is to have.  The date must
  241. consist of pairs of "mm" (month), "dd" (day), and "yy" (year) characters in any
  242. order.  If a delimiter is used between the pairs, it can be any non-space
  243. character (like "-" or "/").  If your delimiter is the same between the three
  244. sets of date portions (e.g.  /DATE=mm/dd/yy or /DATE=dd.mm.yy), you have a
  245. considerable amount of flexibility in terms of what sort of entries can appear.
  246. See the notes at the beginning of this documentation.  Initially defaults to
  247. "/DATE=mm/dd/yy".
  248.  
  249. "/?" or "/HELP" or "HELP" shows you the syntax for the command.
  250.  
  251. "> filename" redirects the output to a DOS file.  This is standard DOS
  252. redirection.  Automatically invokes /Q option and turns off the last of the
  253. status messages.
  254.  
  255.  
  256. Return codes:
  257.  
  258. DATES returns the following ERRORLEVEL codes:
  259.       255 = syntax problems, or /? requested
  260.  
  261. If /R is specified, the ERRORLEVEL code will be the number of hits found.
  262.  
  263.  
  264. Author:
  265.  
  266. This program was written by Bruce Guthrie of Wayne Software.  It is free for use
  267. and redistribution provided relevant documentation is kept with the program, no
  268. changes are made to the program or documentation, and it is not bundled with
  269. commercial programs or charged for separately.  People who need to bundle it in
  270. for-sale packages must pay a $50 registration fee to "Wayne Software" at the
  271. following address.
  272.  
  273. Additional information about this and other Wayne Software programs can be found
  274. in the file BRUCEymm.DOC which should be included in the original ZIP file.
  275. ("ymm" is replaced by the last digit of the year and the two digit month of the
  276. release.  BRUCE312.DOC came out in December 1993.  This same naming convention
  277. is used in naming the ZIP file that this program was included in.) Comments and
  278. suggestions can also be sent to:
  279.  
  280.                 Bruce Guthrie
  281.                 Wayne Software
  282.                 113 Sheffield St.
  283.                 Silver Spring, MD 20910
  284.  
  285.                 fax: (301) 588-8986
  286.  
  287. See BRUCEymm.DOC file for additional contact information.
  288.  
  289. Foreign users:  Please provide an Internet e-mail address in all correspondence.
  290.  
  291.